public interface JavaMailSender extends MailSender
MailSender interface for JavaMail,
supporting MIME messages both as direct arguments and through preparation
callbacks. Typically used in conjunction with the MimeMessageHelper
class for convenient creation of JavaMail MimeMessages,
including attachments etc.
Clients should talk to the mail sender through this interface if they need
mail functionality beyond SimpleMailMessage.
The production implementation is JavaMailSenderImpl; for testing,
mocks can be created based on this interface. Clients will typically receive
the JavaMailSender reference through dependency injection.
The recommended way of using this interface is the MimeMessagePreparator
mechanism, possibly using a MimeMessageHelper for populating the message.
See MimeMessageHelper's javadoc for an example.
The entire JavaMail javax.mail.Session management is abstracted
by the JavaMailSender. Client code should not deal with a Session in any way,
rather leave the entire JavaMail configuration and resource handling to the
JavaMailSender implementation. This also increases testability.
A JavaMailSender client is not as easy to test as a plain
MailSender client, but still straightforward
compared to traditional JavaMail code: Just let createMimeMessage()
return a plain MimeMessage created with a
Session.getInstance(new Properties()) call, and check the passed-in
messages in your mock implementations of the various send methods.
javax.mail.internet.MimeMessage,
javax.mail.Session,
JavaMailSenderImpl,
MimeMessagePreparator,
MimeMessageHelper| Modifier and Type | Method and Description |
|---|---|
MimeMessage |
createMimeMessage()
Create a new JavaMail MimeMessage for the underlying JavaMail Session
of this sender.
|
MimeMessage |
createMimeMessage(java.io.InputStream contentStream)
Create a new JavaMail MimeMessage for the underlying JavaMail Session
of this sender, using the given input stream as the message source.
|
void |
send(MimeMessage mimeMessage)
Send the given JavaMail MIME message.
|
void |
send(MimeMessage[] mimeMessages)
Send the given array of JavaMail MIME messages in batch.
|
MimeMessage createMimeMessage()
send(MimeMessage),
send(MimeMessage[])MimeMessage createMimeMessage(java.io.InputStream contentStream)
throws MailException
contentStream - the raw MIME input stream for the messageMailParseException - in case of message creation failureMailExceptionvoid send(MimeMessage mimeMessage)
throws MailException
createMimeMessage().send in interface MailSendermimeMessage - message to sendMailAuthenticationException - in case of authentication failureMailSendException - in case of failure when sending the messageMailParseException - in case of failure when parsing the messageMailExceptioncreateMimeMessage()void send(MimeMessage[] mimeMessages)
throws MailException
createMimeMessage().send in interface MailSendermimeMessages - messages to sendMailAuthenticationException - in case of authentication failureMailSendException - in case of failure when sending a messageMailParseException - in case of failure when parsing a messageMailExceptioncreateMimeMessage()